home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / programm.ing / shelp.lzh / SHELP / SHELP.TXT < prev   
Encoding:
Text File  |  1995-01-01  |  7.3 KB  |  185 lines
  1. SHelp  Online-Hilfe zu C-Sourcen mit ST-Guide
  2. V0.1  31.12.1994
  3.  
  4. (c) 1994 by Th. Morus Walter
  5.  
  6. Th. Morus Walter
  7. Schulstr. 22
  8. 93080 Pentling
  9. Tel. 0941/949802
  10.  
  11. Dieses Programm ist Freeware!
  12.  
  13. Es darf als Ganzes, d.h. einschließlich der Quellen und dieser Datei, 
  14. beliebig weitergegeben werden. 
  15.  
  16. ---------------------------------------------------------------------------
  17. D I S C L A I M E R:
  18. --------------------
  19. No effort has been made to make this program bugfree.
  20. USE THIS PROGRAM AT YOUR OWN RISK!
  21. NO WARRANTY PROVIDED!
  22.  
  23. Es wurden keinerlei Anstrengungen unternommen, um diese Programm
  24. fehlerfrei zu machen.
  25. BENUTZEN SIE DIESES PROGRAMM AUF EIGENE GEFAHR!
  26. KEINE GARANTIE FÜR IRGENDWAS!
  27.  
  28. Anders gesagt, ich habe das Programm einen Tag lang runtergehackt
  29. Der Parser ist - besonders in Bezug auf Funktionsdefinitionen -
  30. nicht besonders gelungen :-(
  31. Ich habe das Programm an meinen Quelltexten getestet aber ich garantiere
  32. für nichts. (Da die Quellen nur gelesen werden, sollte es aber zu keinen
  33. schwerwiegenderen Problemen als schlimmstenfalls einfachen Abstürzen
  34. kommen)
  35.  
  36. ---------------------------------------------------------------------------
  37.  
  38.  
  39. Sourcen:
  40. --------
  41. Die Sourcen zu Shelp dürfen unter den folgenden Bedingungen weitergegeben, 
  42. verändert und/oder ganz oder teilweise für eigene Programme verwendet werden:
  43.  
  44. 1. Weitergabe ist nur vollständig und mit dieser Datei erlaubt
  45. 2. Veränderte Versionen von Shelp dürfen nur weitergegeben werden, 
  46.    wenn hinreichend deutlich gemacht wird, daß die Programme verändert 
  47.    wurden.
  48.    Änderung des Namens, Hinweise in der Dokumentation, im Programm...
  49.    Es muß in geeigneter Weise auf die ursprüngliche Urheberschaft der
  50.    Programme hingewiesen werden.
  51. 3. die Übernahme von Programmteilen in eigene Programme ist erlaubt.
  52.    Dabei muß in geeigneter Weise auf die Verwendung meiner Routinen
  53.    und deren Urheber verwiesen werden.
  54. 4. die obigen Festlegungen sind nicht wörtlich sondern ihrem Sinne
  55.    entsprechend (was natürlich letztenendes umfassender ist) zu
  56.    befolgen
  57.    (kurz: geht anständig mit meinen Quellen um)
  58.  
  59. ACHTUNG!
  60. Der Autor übernimmt keinerlei Haftung für irgendwelche Schäden.
  61. Eventuelle Fehler sind das Risiko derer, die die Sourcen verwenden.
  62.  
  63. ---------------------------------------------------------------------------
  64.  
  65. ausführliche Beschreibung:
  66. --------------------------
  67. RTFS
  68.  
  69. ---------------------------------------------------------------------------
  70.  
  71. Kurzbeschreibung:
  72. -----------------
  73.  
  74. SHelp erzeugt einen ST-Guide Hypertext (genauer: dessen Quelle), der die
  75. Funktionen, Typ-Definitionen und Präprozessor-Definitionen von C-Quelltexten
  76. enthält.
  77.  
  78. Anmerkungen:
  79. - jede Funktion, jeder definierte Typ und jede #define Anweisung wird
  80.   in einer eigenen Seite des Hypertextes angezeigt.
  81.   Die Seite hat als Titel den Namen der Funktion...
  82.   Sie beginnt mit der Angabe der Quelldatei und der Zeile, wobei der
  83.   Name der Datei einen Link auf diese (mit Berücksichtigung der Zeile)
  84.   darstellt.
  85.   Es folgt der Text der Funktions-, Typ- oder Präprozessor-Definition.
  86.   Bei Funktionsdefinitionen wird alles vom Anfang der Funktionsdefinition 
  87.   bis zum '{', mit dem der Text der Funktion beginnt, ausgegeben, 
  88.   einschließlich Kommentare. Bei #define Anweisungen wird mindestens die
  89.   ganze Zeile ausgegeben, beginnt in ihr ein Kommentar, so wird dieser
  90.   ganz übernommen. Typdefinitionen werden vom 'typedef' bis zum Ende
  91.   der Typdefinition gelesen. Kommentare (etwa bei Strukturen) werden
  92.   ebenfalls übernommen.
  93.  
  94. - an den Anfang des Hypertextes wird eine 'database' Zeile geschrieben,
  95.   deren Inhalt man mit der Option '-i' (wie Info) bestimmen kann.
  96.   Ist '-i' nicht angeben, so wird als Database "Online-Hilfe zu C-Sourcen"
  97.   geschrieben. Letzteres ist zur Identifikation natürlich nur mäßig
  98.   geeignet.
  99.  
  100. - Anschließend wird eine Headerdatei beliebiger Länge und beliebigen 
  101.   Inhaltes in den neuen Hypertext kopiert.
  102.   Zweckmäßigerweise enthält diese die üblichen Angaben wie 'author
  103.   'options' ..., eine Inhaltsseite, eventuell eine Hilfe-Seite usw.
  104.  
  105. - nach allen Einträgen wird für jede der drei Arten von Einträgen
  106.   eine alphabetisch sortierte Index-Seite erzeugt.
  107.   Die Indexseiten heißen 'Funktionen', 'Typ-Definitionen' und
  108.   'Präprozessor-Definitionen'.
  109.  
  110. - es folgt noch eine Liste mit den Quelldateien die verarbeitet wurden
  111.   ('Source-Files').
  112.  
  113. (HCP erzeugt gegebenfalls noch einen Gesamt-Index mit allen Einträgen)
  114.  
  115. Doppelte Namen:
  116. ---------------
  117. Sind irgendwelche Namen aus irgendwelchen Gründen nicht eindeutig,
  118. d.h. kommen sie mehrfach vor, so wird wie folgt verfahren:
  119.  
  120. Haben die doppelten Namen den gleichen Typ (etwa Funktion), so werden
  121. sie nicht geschrieben, es sei denn man hat die Option '-d' gewählt (s.u.).
  122. Ist dies der Fall, so wird der erste Eintrag ganz normal geschrieben,
  123. im zweiten (und allen folgenden) wird der Name des Eintrages durch
  124. ein '.1' ('.2'...) ergänzt. Damit sind die Einträge im Hypertext eindeutig.
  125.  
  126. Haben die doppelten Namen verschiedene Typen so wird der erste Name
  127. wieder normal geschrieben, bei den folgenden der Typ durch '.F', '.T'
  128. oder '.D' markiert.
  129.  
  130. Gegebenenfalls wird sowohl eine Typmarkierung wie eine Nummer angehängt,
  131. die Typmarkierung kommt dann zuerst.
  132.  
  133. Aufruf des Programmes:
  134. ----------------------
  135. shelp [Optionen] File[s]
  136.  
  137. Optionen:
  138. -d    : doppelte Referenzen jedesmal schreiben (.NR zur Kennung)
  139.     s.o.
  140.  
  141. -sSIZE: Puffergröße für Namen angeben (in Kbyte), Default: 64
  142.     sdoku verwendet einen statischen Puffer für die Namen. Läuft dieser
  143.     über, so kann man ihn mit -s vergrößern.
  144.     WICHTIG: zwischen -s und der Größenangabe darf KEIN Space stehen
  145.     (also '-s128', NICHT '-s 16')
  146.     Wendet man sdoku nicht gerade auf Headerdateien großer Resourcefiles
  147.     an, so sollte der Default-Wert im allgemeinen reichen.
  148.  
  149. -bSIZE: Puffergröße für Strukturen/Funktionsköpfe angeben (in Kbyte), Default: 8
  150.     beim Lesen von Strukturen und Funktionsköpfen werden diese zunächst ein
  151.     einen Puffer kopiert (wobei zwei getrennte Puffer existieren). Deren Größe 
  152.     ist also die maximal mögliche Größe für Strukturen und Funktionen.
  153.     WICHTIG: zwischen -b und der Größenangabe darf KEIN Space stehen
  154.  
  155. -hFILE: Headerfile angeben, Default: HEADER.STG
  156.     Name der Headerdatei    
  157.     WICHTIG: zwischen -h und der Datei darf KEIN Space stehen
  158.  
  159. -oFILE: Outputfile angeben, Default: SDOKU.STG
  160.     Name der Ausgabedatei
  161.     WICHTIG: zwischen -h und der Datei darf KEIN Space stehen
  162.  
  163. -iTEXT: Database angeben, Default: "Online-Hilfe zu C-Sourcen"
  164.     WICHTIG: zwischen -i und dem Text darf KEIN Space stehen
  165.      Anführungszeichen werden von SHelp erzeugt
  166.  
  167. -f    : Funktionsdeklarationen ausgeben
  168. -t    : Typ-Definitionen (typedef) ausgeben
  169. -p    : Präprozessor Definitionen ausgeben
  170.         ist weder -f noch -t noch -p gesetzt, so wird -f -t -p verwendet
  171.     Gibt man einen oder zwei der Parameter '-f', '-t' und '-p' an, so kann
  172.     man sich auf bestimmte Typen beschränken.
  173.  
  174. Es können beliebig viele Sourcedateien angegeben werden. Überlange 
  175. Kommandozeilen werden nach dem ARGV-Verfahren unterstützt.
  176.  
  177. Bei Aufruf ohne Parameter und Dateien wird eine Übersicht über die 
  178. Parameter ausgegeben.
  179.  
  180. Fehler:
  181. -------
  182. wenn was schiefgeht, terminiert SHelp unter Ausgabe einer Fehlermeldung.
  183. Die bisher geschriebene Ausgabe wird NICHT gelöscht.
  184.  
  185.